/*
 * Copyright (c) 2012, marco.tamburelli@gmail.com
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met: 
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.bmi.gwt.ws.rebind;

import org.bmi.gwt.ws.rebind.util.SerializableTypeOracleBuilder;

import com.google.gwt.core.ext.TreeLogger;
import com.google.gwt.core.ext.UnableToCompleteException;
import com.google.gwt.core.ext.typeinfo.JClassType;
import com.google.gwt.core.ext.typeinfo.NotFoundException;
import com.google.gwt.core.ext.typeinfo.TypeOracle;
import com.google.gwt.user.client.rpc.IncompatibleRemoteServiceException;
import com.google.gwt.user.client.rpc.RpcToken;
import com.google.gwt.user.client.rpc.RpcTokenException;

final class TypesSerializationUtil
{
	/**
	 * Adds a root type for each type that appears in the RemoteService
	 * interface methods.
	 */
	static void addRemoteServiceRootTypes(TreeLogger logger, TypeOracle typeOracle,
			SerializableTypeOracleBuilder typesSentFromBrowser, SerializableTypeOracleBuilder typesSentToBrowser,
			JClassType typeToSerialize) throws NotFoundException, UnableToCompleteException
	{
		JClassType rteType = typeOracle.getType(RpcTokenException.class.getName());
		JClassType rpcTokenClass = typeOracle.getType(RpcToken.class.getName());

		JClassType[] rpcTokenSubclasses = rpcTokenClass.getSubtypes();
		for (JClassType rpcTokenSubclass : rpcTokenSubclasses)
		{
			typesSentFromBrowser.addRootType(logger, rpcTokenSubclass);
		}
		if (rpcTokenSubclasses.length > 0)
		{
			typesSentToBrowser.addRootType(logger, rteType);
		}

		typesSentToBrowser.addRootType(logger, typeToSerialize);
		typesSentFromBrowser.addRootType(logger, typeToSerialize);
	}

	/**
	 * Add the implicit root types that are needed to make RPC work. These would
	 * be {@link String} and {@link IncompatibleRemoteServiceException}.
	 */
	static void addRequiredRoots(TreeLogger logger, TypeOracle typeOracle, SerializableTypeOracleBuilder stob)
			throws NotFoundException
	{
		logger = logger.branch(TreeLogger.DEBUG, "Analyzing implicit types");

		/* String is always instantiable. */
		JClassType stringType = typeOracle.getType(String.class.getName());
		stob.addRootType(logger, stringType);

		/* IncompatibleRemoteServiceException is always serializable */
		JClassType icseType = typeOracle.getType(IncompatibleRemoteServiceException.class.getName());
		stob.addRootType(logger, icseType);
	}
}
